.\"-
.\" Copyright (c) 2008 Apple Inc.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1.  Redistributions of source code must retain the above copyright
.\"     notice, this list of conditions and the following disclaimer.
.\" 2.  Redistributions in binary form must reproduce the above copyright
.\"     notice, this list of conditions and the following disclaimer in the
.\"     documentation and/or other materials provided with the distribution.
.\" 3.  Neither the name of Apple Inc. ("Apple") nor the names of
.\"     its contributors may be used to endorse or promote products derived
.\"     from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR
.\" ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE. 
.\"
.Dd December 28, 2008
.Dt AU_BSM_TO_SOCKET_TYPE 3
.Os
.Sh NAME
.Nm au_bsm_to_socket_type ,
.Nm au_socket_type_to_bsm
.Nd "convert between BSM and local socket types"
.Sh LIBRARY
.Lb libbsm
.Sh SYNOPSIS
.In bsm/libbsm.h
.Ft int
.Fn au_bsm_to_socket_type "u_short bsm_socket_type" "int *local_socket_typep"
.Ft u_short
.Fn au_socket_type_to_bsm "int local_socket_type"
.Sh DESCRIPTION
These interfaces may be used to convert between the local and BSM socket
types.
The
.Fn au_bsm_to_socket_type
function accepts a BSM socket type,
.Fa bsm_socket_type ,
and converts it to a local socket type, such as those passed to
.Xr socket 2 ,
that will be stored in the integer pointed to by
.Fa local_socket_typep
if successful.
This call will fail if the BSM socket type cannot be mapped into a local
socket type, which may occur if the socket token was generated on another
operating system.
.Pp
.Fn au_socket_type_to_bsm
function accepts a local socket type, and returns the BSM socket type for it.
This call cannot fail, and instead returns a BSM socket type indicating to a
later decoder that the socket type could not be encoded.
.Sh RETURN VALUES
On success,
.Fn au_bsm_to_socket_type
returns 0 and a converted socket type; on failure, it returns -1 but does not
set
.Xr errno 2 .
.Pp
On success,
.Fn au_strerror
returns a pointer to an error string; on failure it will return
.Dv NULL .
.Sh SEE ALSO
.Xr au_bsm_to_domain 3 ,
.Xr au_domain_to_bsm 3 ,
.Xr au_to_socket_ex 3 ,
.Xr libbsm 3
.Sh HISTORY
.Fn au_bsm_to_socket_type
and
.Fn au_socket_type_to_bsm
were introduced in OpenBSM 1.1.
.Sh AUTHORS
These functions were implemented by
.An Robert Watson
under contract to Apple Inc.
.Pp
The Basic Security Module (BSM) interface to audit records and audit event
stream format were defined by Sun Microsystems.
